.. _cmcHomeGetConfig:

cmcHomeGetConfig
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmcHomeGetConfig([in] VT_I4 BoardID, [in] VT_I4 Channel, [in] VT_I4 ParamId, [out] VT_PI4 ParamVal)          

DESCRIPTION
`````````````  

- cmcHomeGetConfig() 함수는 원점복귀 작업에 관련된 환경 설정값을 확인(確認)합니다. 

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cmc 가 붙지 않습니다.


PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 
 
▶ Channel : 축(채널) 번호. 축번호는 상수값으로  0번째 채널을 기준 채널로 임의의 채널을 
설정할 수 있습니다. 
 
▶ ParamId : 설정하고자 하는 파라미터 ID 값을 지정합니다.해당 ID값의 의미는 다음과 
같습니다. 

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    "| 0 또는 cmcHPID_HOME_MODE", "
     |                              원점복귀를 수행 할 때 사용할 복귀 방법을 지정합니다.
     |                              "
    "| 1 또는 cmcHPID_HOME_DIR", "
     |                             원점복귀를 수행 할 방향을 지정합니다. 
     |                             "           
    "| 2 또는 CmHPID_HOME_OFFSET", "
     |                              원점복귀를 완료 후 추가로 이동할 거리를 지정합니다. 
     |                              "     

▶ ParamVal : cmcHomeSetConfig함수의 인자이며, 파라미터 ID값에 따른 실제 지정하고자 
하는 파라미터의 적용 값을 의미합니다. 각값의 적용범위는 파라미터ID 별로 다르며 해당 
값의 의미는 다음 표와 같습니다.      
      
- ParamID 가 0 인 경우

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    "| 1 또는 cmcHOME_MODE_ORG ", "
     |                             원점센서를 사용한 원점복귀를 시행합니다.
     |                             "           
    "| 3 또는 cmcHOME_MODE_EL", "
     |                              EL 센서를 사용한 원점복귀를 시행합니다. 
     |                              "    

     
- ParamID 가 1 인 경우

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    "| 0 또는 cmcDIR_N ", "
     |                      음의 방향으로 원점복귀를 시행합니다."
    "| 1 또는 cmcDIR_P  ", "
     |                      양의 방향으로 원점복귀를 시행합니다."

- ParamID 가 2 인 경우

  .. csv-table::
   :widths: 100
   :header-rows: 1
   :stub-columns: 0

    Meaning
   "| 원점 복귀 위치에서 일정거리 이상을 상대 이동할 필요가 있을 경우, 
    | 그 값을 설정합니다. 이것은 원점 복귀 종료 위치를 기준으로 
    | 추가 모션 이동을 의미합니다."

▶ ParamVal : cmcHomeGetConfig 함수의 인자이며, 파라미터 ID값에 따른 실제 지정된 
파라미터의 적용 값을 반환합니다. 


RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+